<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>Paho C++: mqtt::exception Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="pahologo.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">Paho C++
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">The Paho MQTT C++ Client Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classmqtt_1_1exception.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Friends</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classmqtt_1_1exception-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">mqtt::exception Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Base <a class="el" href="classmqtt_1_1exception.html" title="Base mqtt::exception. ">mqtt::exception</a>.  
 <a href="classmqtt_1_1exception.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="exception_8h_source.html">exception.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for mqtt::exception:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classmqtt_1_1exception.png" usemap="#mqtt::exception_map" alt=""/>
  <map id="mqtt::exception_map" name="mqtt::exception_map">
<area href="classmqtt_1_1persistence__exception.html" title="This exception is thrown by the implementor of the persistence interface if there is a problem readin..." alt="mqtt::persistence_exception" shape="rect" coords="0,168,165,192"/>
<area href="classmqtt_1_1security__exception.html" title="Thrown when a client is not authorized to perform an operation, or if there is a problem with the sec..." alt="mqtt::security_exception" shape="rect" coords="175,168,340,192"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa3a071afd78ef300657e55f4cb283c5f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1exception.html#aa3a071afd78ef300657e55f4cb283c5f">exception</a> (int code)</td></tr>
<tr class="memdesc:aa3a071afd78ef300657e55f4cb283c5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an MQTT exception.  <a href="#aa3a071afd78ef300657e55f4cb283c5f">More...</a><br/></td></tr>
<tr class="separator:aa3a071afd78ef300657e55f4cb283c5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2e3ce1f786e91918cb07d60c37b9831"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1exception.html#ac2e3ce1f786e91918cb07d60c37b9831">exception</a> (int code, const string &amp;msg)</td></tr>
<tr class="memdesc:ac2e3ce1f786e91918cb07d60c37b9831"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an MQTT exception.  <a href="#ac2e3ce1f786e91918cb07d60c37b9831">More...</a><br/></td></tr>
<tr class="separator:ac2e3ce1f786e91918cb07d60c37b9831"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa59b0018945b86f1c35e5f8fb45edca4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa59b0018945b86f1c35e5f8fb45edca4"></a>
string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1exception.html#aa59b0018945b86f1c35e5f8fb45edca4">get_message</a> () const </td></tr>
<tr class="memdesc:aa59b0018945b86f1c35e5f8fb45edca4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the error message for this exception. <br/></td></tr>
<tr class="separator:aa59b0018945b86f1c35e5f8fb45edca4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2480065a73ba2682e37246fdd1707d7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac2480065a73ba2682e37246fdd1707d7"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1exception.html#ac2480065a73ba2682e37246fdd1707d7">get_reason_code</a> () const </td></tr>
<tr class="memdesc:ac2480065a73ba2682e37246fdd1707d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the reason code for this exception. <br/></td></tr>
<tr class="separator:ac2480065a73ba2682e37246fdd1707d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10e59c8ab2760198d51a61ee152c92f5"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1exception.html#a10e59c8ab2760198d51a61ee152c92f5">to_string</a> () const </td></tr>
<tr class="memdesc:a10e59c8ab2760198d51a61ee152c92f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a string representation of this exception.  <a href="#a10e59c8ab2760198d51a61ee152c92f5">More...</a><br/></td></tr>
<tr class="separator:a10e59c8ab2760198d51a61ee152c92f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ae44c9bab2cb65df05e4fc3c74432da1c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae44c9bab2cb65df05e4fc3c74432da1c"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1exception.html#ae44c9bab2cb65df05e4fc3c74432da1c">code_</a></td></tr>
<tr class="memdesc:ae44c9bab2cb65df05e4fc3c74432da1c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The error code from the C library. <br/></td></tr>
<tr class="separator:ae44c9bab2cb65df05e4fc3c74432da1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61667eac1252ec9e4e1b2e9667c1f0f9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a61667eac1252ec9e4e1b2e9667c1f0f9"></a>
string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1exception.html#a61667eac1252ec9e4e1b2e9667c1f0f9">msg_</a></td></tr>
<tr class="memdesc:a61667eac1252ec9e4e1b2e9667c1f0f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">The error message from the C library. <br/></td></tr>
<tr class="separator:a61667eac1252ec9e4e1b2e9667c1f0f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base <a class="el" href="classmqtt_1_1exception.html" title="Base mqtt::exception. ">mqtt::exception</a>. </p>
<p>This wraps the error codes which originate from the underlying C library. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aa3a071afd78ef300657e55f4cb283c5f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">mqtt::exception::exception </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>code</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Creates an MQTT exception. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">code</td><td>The error code from the C library. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ac2e3ce1f786e91918cb07d60c37b9831"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">mqtt::exception::exception </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>code</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const string &amp;&#160;</td>
          <td class="paramname"><em>msg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Creates an MQTT exception. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">code</td><td>The error code from the C library. </td></tr>
    <tr><td class="paramname">msg</td><td>The text message for the error. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a10e59c8ab2760198d51a61ee152c92f5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">string mqtt::exception::to_string </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Gets a string representation of this exception. </p>
<dl class="section return"><dt>Returns</dt><dd>A string representation of this exception. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/mqtt/<a class="el" href="exception_8h_source.html">exception.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><b>mqtt</b></li><li class="navelem"><a class="el" href="classmqtt_1_1exception.html">exception</a></li>
    <li class="footer">Generated on Sun Jul 23 2017 10:24:29 for Paho C++ by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>
